gridpack::component::BaseBranchComponent Class Reference

#include <base_component.hpp>

Inheritance diagram for gridpack::component::BaseBranchComponent:

[legend]

Collaboration diagram for gridpack::component::BaseBranchComponent:

[legend]

List of all members.

Public Member Functions
	BaseBranchComponent (void)
virtual	~BaseBranchComponent (void)
void	setBus1 (const boost::shared_ptr< BaseComponent > &bus)
void	setBus2 (const boost::shared_ptr< BaseComponent > &bus)
boost::shared_ptr< BaseComponent >	getBus1 (void) const
boost::shared_ptr< BaseComponent >	getBus2 (void) const
void	clearBuses (void)
void	setGlobalIndex (int idx)
void	setBus1OriginalIndex (int idx)
void	setBus2OriginalIndex (int idx)
void	setBus1GlobalIndex (int idx)
void	setBus2GlobalIndex (int idx)
int	getBus1OriginalIndex (void) const
int	getBus2OriginalIndex (void) const
int	getBus1GlobalIndex (void) const
int	getBus2GlobalIndex (void) const
int	getGlobalIndex (void) const

---

Constructor & Destructor Documentation

gridpack::component::BaseBranchComponent::BaseBranchComponent

(

void

)

Simple constructor

virtual gridpack::component::BaseBranchComponent::~BaseBranchComponent

(

void

)

[virtual]

Simple destructor

---

Member Function Documentation

void gridpack::component::BaseBranchComponent::clearBuses

(

void

)

Clear bus pointers

boost::shared_ptr<BaseComponent> gridpack::component::BaseBranchComponent::getBus1

(

void

)

const

Get pointer to bus at one end of branch

Returns:

pointer to bus 1

int gridpack::component::BaseBranchComponent::getBus1GlobalIndex

(

void

)

const

Get global index for bus 1

Returns:

global index for bus 1

int gridpack::component::BaseBranchComponent::getBus1OriginalIndex

(

void

)

const

Get original index for bus 1

Returns:

original index for bus 1

boost::shared_ptr<BaseComponent> gridpack::component::BaseBranchComponent::getBus2

(

void

)

const

Get pointer to bus at other end of branch

Returns:

pointer to bus 2

int gridpack::component::BaseBranchComponent::getBus2GlobalIndex

(

void

)

const

Get global index for bus 2

Returns:

global index for bus 2

int gridpack::component::BaseBranchComponent::getBus2OriginalIndex

(

void

)

const

Get original index for bus 2

Returns:

original index for bus 2

int gridpack::component::BaseBranchComponent::getGlobalIndex

(

void

)

const

Get global index for branch

void gridpack::component::BaseBranchComponent::setBus1

(

const boost::shared_ptr< BaseComponent > &

bus

)

Set pointer to bus at one end of branch

Parameters:

bus

pointer to bus

void gridpack::component::BaseBranchComponent::setBus1GlobalIndex

(

int

idx

)

Set global index (from network) for bus 1

Parameters:

idx

global index for bus 1

void gridpack::component::BaseBranchComponent::setBus1OriginalIndex

(

int

idx

)

Set original index for bus 1

Parameters:

idx

original index for bus 1 (assigned from input file)

void gridpack::component::BaseBranchComponent::setBus2

(

const boost::shared_ptr< BaseComponent > &

bus

)

Set pointer to bus at other end of branch

Parameters:

bus

pointer to bus

void gridpack::component::BaseBranchComponent::setBus2GlobalIndex

(

int

idx

)

Set global index (from network) for bus 2

Parameters:

idx

global index for bus 2

void gridpack::component::BaseBranchComponent::setBus2OriginalIndex

(

int

idx

)

Set original index for bus 2

Parameters:

idx

original index for bus 2 (assigned from input file)

void gridpack::component::BaseBranchComponent::setGlobalIndex

(

int

idx

)

Set global index for branch

Parameters:

idx

global index of branch

---

The documentation for this class was generated from the following file:

• base_component.hpp